Clean up JavaScriptCore & legacy Chrome debugger RPC layer #4203

kraenhansen · 2022-01-10T16:28:28Z

What, How & Why?

Now that our support for JavaScriptCore on the hermes branch is entirely through the JSI (JavaScript Interface), we can remove our direct implementation to JavaScriptCore and the legacy Chrome Debugger implementation (which was implemented tightly coupled with the JSC API).

The experience of running in legacy Chrome debugging mode

Users starting an app that requires Realm from Chrome debugging mode will now experience the following:

This version of Realm JS doesn't support the legacy Chrome Debugger

☑️ ToDos

📝 Changelog entry
📝 Compatibility label is updated or copied from previous entry
🚦 Tests (manually)
📱 Check the React Native/other sample apps work if necessary
📝 Public documentation PR created or is not necessary
💥 Breaking label has been applied or is not necessary

If this PR adds or changes public API's:

typescript definitions file is updated
jsdoc files updated
Chrome debug API is updated if API is available on React Native (for the last time)

fronck · 2022-01-10T16:56:01Z

lib/react-native/index.js

 // Otherwise, we must be in a "normal" react native situation.
 // In that case, the Realm type should have been injected by the native code.
 // If it hasn't, the user likely forgot to install the RealmJS CocoaPod
-if (typeof global.Realm === "undefined") {
+if (typeof Realm === "undefined") {
  throw new Error(
    'Missing Realm constructor. Did you run "pod install"? Please see https://realm.io/docs/react-native/latest/#missing-realm-constructor for troubleshooting',


This URL ends up in a 403.
This error message isn't mentioned in our current documentation, but can be found in the legacy documentation and in this blog post.

I agree, it does make sense to update the URL in this PR too.

I think we should remove the link altogether. The docs site is no longer something we control, so the URL may change at any time..

kneth

Feels so good!

kneth · 2022-01-11T08:08:19Z

CHANGELOG.md

+x.x.x Release notes (yyyy-MM-dd)
+=============================================================
+### Breaking change
+* Removed all code related to the legacy Chrome Debugger.


Suggested change

* Removed all code related to the legacy Chrome Debugger.

* Removed all code related to the legacy Chrome Debugger. Please use [Flipper](https://fbflipper.com/) as debugger.

kneth · 2022-01-11T08:10:19Z

lib/react-native/index.js

+const usingLegacyChromeDebugger = typeof DedicatedWorkerGlobalScope !== "undefined";
+
+if (usingLegacyChromeDebugger) {
+  throw new Error("This version of Realm JS doesn't support the legacy Chrome Debugger");


Suggested change

throw new Error("This version of Realm JS doesn't support the legacy Chrome Debugger");

throw new Error("This version of Realm JS doesn't support the legacy Chrome Debugger. Please use Flipper instead.");

fronck · 2022-01-11T10:57:47Z

lib/index.js

-      throw new Error("Unexpected execution environment (" + environment + ")");
-  }
+const environment = utils.getEnvironment();
+if (environment !== "node.js" || environment !== "electron") {


Can "reactnative" or "jscore" no longer be our environment here?

Right. With the react-native main field in the package.json, this code will no longer be hit on React Native.

fronck

Nice work getting rid of this old cruft 👍

kraenhansen · 2022-01-17T10:53:55Z

Merging with these failing tests:

Integration Tests via Node.js v14 on Window (debug & release build): The npm ci isn't happening with NPM v7 fails the build. It does pass on v16, so I think it's okay to disregard this for this PR and fix it later.
Test runners on Linux failed, but it already passed on a previous commit and it succeeded on MacOS with this commit, I don't see a need to rerun the build to verify.

* Removed 0xd3adc0d3 * Providing a "soft" landing for users running in legacy debugging mode * Simplified index.js as we have react-native/index.js * Removed some logging * Adding a note to the CHANGELOG * Stop integration testing in legacy debug mode * Incorporated feedback * Fixed the environment check 🤦‍♂️ * Removed all mentions of GCDWebServer

Clean up JavaScriptCore & legacy Chrome debugger RPC layer (#4203) * Removed 0xd3adc0d3 * Providing a "soft" landing for users running in legacy debugging mode * Simplified index.js as we have react-native/index.js * Removed some logging * Adding a note to the CHANGELOG * Stop integration testing in legacy debug mode * Incorporated feedback * Fixed the environment check 🤦‍♂️ * Removed all mentions of GCDWebServer Prevent dangling objects on JSCRuntime destruction (#4228) * WIP * Refactored to a separate js_notifications.hpp * Using the NotificationBucket throughout the codebase * Adding a note to the changelog * Fixed compiling on GCC * Trigger garbage collection after every test * Ensure s_tokens static gets initialized before use Removed a bash only prepare command

* [10.20.0-alpha.0] PRE-RELEASE - DO NOT USE IN PRODUCTION * [10.20.0-alpha.1] Bump version * [10.20.0-alpha.2] Bump version Rename namespaces in the JSI codebase to reflect that it doesn't just support Hermes (#4079) Rework the namespace names in our Hermes/JSI layer to more accurately reflect that we support JSI, and to remove ambiguities and namespace clashes. This closes RJS-1337. Fixing C++ lint error * [10.20.0-beta.0] Bump version Hermes: Fixing a couple of breaking tests (#4120) * Relaxing error message asserting tests * Fixing testListSubscriptSetters Catching missing libjsi.so as librealm.so loads (#4123) Updated RN peer dependency version (#4124) Fix classes not extending `Realm.Object` (#4125) * Fixing custom classes not extending Realm.Object * Adding a note to the changelog * Update CHANGELOG.md Co-authored-by: FFranck <franck.franck@mongodb.com> Co-authored-by: FFranck <franck.franck@mongodb.com> Fixed throwing "Illegal constructor" (#4128) Clarifying the get_internal early return Refixed throwing "Illegal constructor" Various JSI fixes to greenlight more tests (#4129) Flipper doesnt support inlined sourcemaps Return an existing s_ctor Testing with Hermes on CI (#4106) * Adding hermes as target branch for the integration tests workflow * Reading environment variable when enabling Hermes * Adding test app to watchable directories * Adding a hermes variant when testing React Native * Making the ccache engine specific * Moved react-native entry point to fix lint error * Attempt at fixing ReactTestAppTests * Update Podfile to work around the Catalyst issue Fixes for type conversions and minor cleanups (#4137) * [10.20.0-beta.1] Bump version Clean up JavaScriptCore & legacy Chrome debugger RPC layer (#4203) * Removed 0xd3adc0d3 * Providing a "soft" landing for users running in legacy debugging mode * Simplified index.js as we have react-native/index.js * Removed some logging * Adding a note to the CHANGELOG * Stop integration testing in legacy debug mode * Incorporated feedback * Fixed the environment check 🤦‍♂️ * Removed all mentions of GCDWebServer Prevent dangling objects on JSCRuntime destruction (#4228) * WIP * Refactored to a separate js_notifications.hpp * Using the NotificationBucket throughout the codebase * Adding a note to the changelog * Fixed compiling on GCC * Trigger garbage collection after every test * Ensure s_tokens static gets initialized before use Removed a bash only prepare command * [10.20.0-beta.2] Bump version Adding changelog template Updated package-locks Copied up the change log * [10.20.0-beta.3] Bump version * [10.20.0-beta.4] Bump version Hermes: Adding an index.native.js (#4461) * Ading an index.native.js to help bundlers * Adding a note to the changelog Update CMakeLists.txt to resolve "react-native" (#4466) * Update CMakeLists.txt to resolve "react-native" This enables end-users to build the iOS XCFramework locally from our npm package, if they need it built with the same version of Xcode as they're using to build their app. * Update CHANGELOG.md * Updating package-lock.json * Adding changelog template * [10.20.0-beta.5] Bump version * Adding changelog template * Rolling up relevant notes in changelog * Class models: `Realm.Object#constructor` for JSI / Hermes (#4435) * Create prototyped object instead of constructor call Recreated package-lock * Ran lint fix Co-authored-by: Mathias Stearn <redbeard0531@gmail.com>

* [10.20.0-alpha.0] PRE-RELEASE - DO NOT USE IN PRODUCTION * [10.20.0-alpha.1] Bump version * [10.20.0-alpha.2] Bump version Rename namespaces in the JSI codebase to reflect that it doesn't just support Hermes (#4079) Rework the namespace names in our Hermes/JSI layer to more accurately reflect that we support JSI, and to remove ambiguities and namespace clashes. This closes RJS-1337. Fixing C++ lint error * [10.20.0-beta.0] Bump version Hermes: Fixing a couple of breaking tests (#4120) * Relaxing error message asserting tests * Fixing testListSubscriptSetters Catching missing libjsi.so as librealm.so loads (#4123) Updated RN peer dependency version (#4124) Fix classes not extending `Realm.Object` (#4125) * Fixing custom classes not extending Realm.Object * Adding a note to the changelog * Update CHANGELOG.md Co-authored-by: FFranck <franck.franck@mongodb.com> Co-authored-by: FFranck <franck.franck@mongodb.com> Fixed throwing "Illegal constructor" (#4128) Clarifying the get_internal early return Refixed throwing "Illegal constructor" Various JSI fixes to greenlight more tests (#4129) Flipper doesnt support inlined sourcemaps Return an existing s_ctor Testing with Hermes on CI (#4106) * Adding hermes as target branch for the integration tests workflow * Reading environment variable when enabling Hermes * Adding test app to watchable directories * Adding a hermes variant when testing React Native * Making the ccache engine specific * Moved react-native entry point to fix lint error * Attempt at fixing ReactTestAppTests * Update Podfile to work around the Catalyst issue Fixes for type conversions and minor cleanups (#4137) * [10.20.0-beta.1] Bump version Clean up JavaScriptCore & legacy Chrome debugger RPC layer (#4203) * Removed 0xd3adc0d3 * Providing a "soft" landing for users running in legacy debugging mode * Simplified index.js as we have react-native/index.js * Removed some logging * Adding a note to the CHANGELOG * Stop integration testing in legacy debug mode * Incorporated feedback * Fixed the environment check 🤦‍♂️ * Removed all mentions of GCDWebServer Prevent dangling objects on JSCRuntime destruction (#4228) * WIP * Refactored to a separate js_notifications.hpp * Using the NotificationBucket throughout the codebase * Adding a note to the changelog * Fixed compiling on GCC * Trigger garbage collection after every test * Ensure s_tokens static gets initialized before use Removed a bash only prepare command * [10.20.0-beta.2] Bump version Adding changelog template Updated package-locks Copied up the change log * [10.20.0-beta.3] Bump version * [10.20.0-beta.4] Bump version Hermes: Adding an index.native.js (#4461) * Ading an index.native.js to help bundlers * Adding a note to the changelog Update CMakeLists.txt to resolve "react-native" (#4466) * Update CMakeLists.txt to resolve "react-native" This enables end-users to build the iOS XCFramework locally from our npm package, if they need it built with the same version of Xcode as they're using to build their app. * Update CHANGELOG.md * Updating package-lock.json * Adding changelog template * [10.20.0-beta.5] Bump version * Adding changelog template * Rolling up relevant notes in changelog * Class models: `Realm.Object#constructor` for JSI / Hermes (#4435) * Create prototyped object instead of constructor call Recreated package-lock * Ran lint fix Co-authored-by: Mathias Stearn <redbeard0531@gmail.com> Updated the merge

Squashed commit of the following: commit a3747c1 Author: Andrew Meyer <andrew.meyer@mongodb.com> Date: Wed Aug 31 14:19:18 2022 +0200 Fix TypeScript errors in @realm/react (#4847) Changes to class based models caused @realm/react to break. This addresses these changes. commit f75302f Author: Andrew Meyer <andrew.meyer@mongodb.com> Date: Wed Aug 31 11:54:08 2022 +0200 Quick lint fix (#4845) commit dcabed2 Author: Andrew Meyer <andrew.meyer@mongodb.com> Date: Tue Aug 30 14:35:11 2022 +0200 Prepare CHANGELOG commit 0a366fb Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Sat Jul 16 08:58:05 2022 +0200 Small fix for RN integration test app commit 343d668 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Mon Jul 11 16:44:29 2022 +0200 [11.0.0-rc.1] Bump version commit 6d6a71a Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Mon Jul 11 16:39:09 2022 +0200 Upgraded JSI header to React Native 0.69.1 commit cd813a4 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Thu Jul 7 12:16:52 2022 +0200 Adding changelog template commit 10682c2 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Thu Jul 7 11:51:25 2022 +0200 Removing realm-core and src sourcecode from the NPM bundle commit 399b5a1 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Thu Jul 7 09:32:14 2022 +0200 [11.0.0-rc.0] Bump version commit c984d1f Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Thu Jul 7 11:01:52 2022 +0200 Attempt fixing CI issue commit 8daa0b9 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Mon Jul 4 12:06:05 2022 +0200 Update README.md (#4645) commit f46c812 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Wed Jun 8 16:30:35 2022 +0200 Fixed CPP lint issues commit 0788430 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Wed Jun 8 16:12:11 2022 +0200 Fixed failing a test commit 5250743 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Tue May 17 12:19:46 2022 +0200 Add calls to flush_ui_queue for Hermes (#4579) Rearranged jsi_init Refactored flush of UI queue for JSI commit 2b9c8b4 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Wed Jun 8 16:08:55 2022 +0200 Avoid copying args (#4629) commit e1adfc7 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Tue Jun 7 16:52:03 2022 +0200 Rebuild package-lock.json Updating package-lock Rebuild package-lock.json commit 2251bd8 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Tue May 17 12:19:46 2022 +0200 Rearranged jsi_init commit d3cdd3c Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Fri Apr 29 12:45:26 2022 +0200 Class-based Models types (#4537) * Improving ClassModel type * Fixed changelog commit f02ad56 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Thu Apr 28 17:18:52 2022 +0200 Support the Hermes JS engine through JSI (#4536) * [10.20.0-alpha.0] PRE-RELEASE - DO NOT USE IN PRODUCTION * [10.20.0-alpha.1] Bump version * [10.20.0-alpha.2] Bump version Rename namespaces in the JSI codebase to reflect that it doesn't just support Hermes (#4079) Rework the namespace names in our Hermes/JSI layer to more accurately reflect that we support JSI, and to remove ambiguities and namespace clashes. This closes RJS-1337. Fixing C++ lint error * [10.20.0-beta.0] Bump version Hermes: Fixing a couple of breaking tests (#4120) * Relaxing error message asserting tests * Fixing testListSubscriptSetters Catching missing libjsi.so as librealm.so loads (#4123) Updated RN peer dependency version (#4124) Fix classes not extending `Realm.Object` (#4125) * Fixing custom classes not extending Realm.Object * Adding a note to the changelog * Update CHANGELOG.md Co-authored-by: FFranck <franck.franck@mongodb.com> Co-authored-by: FFranck <franck.franck@mongodb.com> Fixed throwing "Illegal constructor" (#4128) Clarifying the get_internal early return Refixed throwing "Illegal constructor" Various JSI fixes to greenlight more tests (#4129) Flipper doesnt support inlined sourcemaps Return an existing s_ctor Testing with Hermes on CI (#4106) * Adding hermes as target branch for the integration tests workflow * Reading environment variable when enabling Hermes * Adding test app to watchable directories * Adding a hermes variant when testing React Native * Making the ccache engine specific * Moved react-native entry point to fix lint error * Attempt at fixing ReactTestAppTests * Update Podfile to work around the Catalyst issue Fixes for type conversions and minor cleanups (#4137) * [10.20.0-beta.1] Bump version Clean up JavaScriptCore & legacy Chrome debugger RPC layer (#4203) * Removed 0xd3adc0d3 * Providing a "soft" landing for users running in legacy debugging mode * Simplified index.js as we have react-native/index.js * Removed some logging * Adding a note to the CHANGELOG * Stop integration testing in legacy debug mode * Incorporated feedback * Fixed the environment check 🤦‍♂️ * Removed all mentions of GCDWebServer Prevent dangling objects on JSCRuntime destruction (#4228) * WIP * Refactored to a separate js_notifications.hpp * Using the NotificationBucket throughout the codebase * Adding a note to the changelog * Fixed compiling on GCC * Trigger garbage collection after every test * Ensure s_tokens static gets initialized before use Removed a bash only prepare command * [10.20.0-beta.2] Bump version Adding changelog template Updated package-locks Copied up the change log * [10.20.0-beta.3] Bump version * [10.20.0-beta.4] Bump version Hermes: Adding an index.native.js (#4461) * Ading an index.native.js to help bundlers * Adding a note to the changelog Update CMakeLists.txt to resolve "react-native" (#4466) * Update CMakeLists.txt to resolve "react-native" This enables end-users to build the iOS XCFramework locally from our npm package, if they need it built with the same version of Xcode as they're using to build their app. * Update CHANGELOG.md * Updating package-lock.json * Adding changelog template * [10.20.0-beta.5] Bump version * Adding changelog template * Rolling up relevant notes in changelog * Class models: `Realm.Object#constructor` for JSI / Hermes (#4435) * Create prototyped object instead of constructor call Recreated package-lock * Ran lint fix Co-authored-by: Mathias Stearn <redbeard0531@gmail.com> Updated the merge commit 02d1149 Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Wed Mar 30 16:28:08 2022 +0200 Class models: `Realm.Object#constructor` (#4427) * Adding a cast to Value operator on ReturnType * Adding integration tests of class constructors * Made the test reporter print stack * Implemented Realm.Object constructor * Added node implementation and fixed legacy tests * Read from this.constructor instead of new.target * Fixing JSC implementation * Updating types and tests * Fixed Person and Dog constructors * Updated @realm/react useObject + useQuery * Updated types to fix an issue * Dead code removal * Updated tests to use default values * Making the insertion types a bit more loose * Adding documentation * Renamed realm_object_object * Made the constructor "values" required * Renamed "RealmInsertionModel" to "Unmanged" * Adding a note to the changelog * Apply suggestions to docstrings Co-authored-by: Kenneth Geisshirt <k@zigzak.net> * Add docstring of set_internal and get_internal * Expect 2 arguments on the C++ code as well Co-authored-by: Kenneth Geisshirt <k@zigzak.net> commit 18146be Author: Kræn Hansen <kraen.hansen@mongodb.com> Date: Wed Mar 16 12:03:46 2022 +0100 Class models: Enforce `extends Realm.Object` (#4417) * Throw if constructors doesn't extend Realm.Object * Updating existing tests to the breaking change. * Adding a note to the changelog Attempt at fixing Android build Fixed broken Android merge

CraftsmanTech11 · 2022-11-13T12:26:27Z

I am switching to sqlite , just becouse realm does not support chrome debugger (but flipper, dont know why)

kraenhansen added T-Internal Breaking labels Jan 10, 2022

kraenhansen self-assigned this Jan 10, 2022

cla-bot bot added the cla: yes label Jan 10, 2022

kraenhansen requested review from fronck and kneth January 10, 2022 16:30

fronck reviewed Jan 10, 2022

View reviewed changes

kneth approved these changes Jan 11, 2022

View reviewed changes

fronck reviewed Jan 11, 2022

View reviewed changes

fronck approved these changes Jan 11, 2022

View reviewed changes

kraenhansen force-pushed the kh/hermes/cleanup branch from 54436c6 to 6a3ebd7 Compare January 12, 2022 09:06

takameyer mentioned this pull request Jan 17, 2022

The TsExample shows realm constructor must not return another value during debug with chrome #4225

Closed

kraenhansen force-pushed the kh/hermes/cleanup branch from 8fd5016 to 6a3ebd7 Compare January 17, 2022 09:39

kraenhansen force-pushed the hermes branch from caef0cc to f7a3aa0 Compare January 17, 2022 09:53

kraenhansen added 9 commits January 17, 2022 10:55

Removed 0xd3adc0d3

06bbf7f

Providing a "soft" landing for users running in legacy debugging mode

cb01334

Simplified index.js as we have react-native/index.js

c393c46

Removed some logging

21a3cf2

Adding a note to the CHANGELOG

801b999

Stop integration testing in legacy debug mode

14aa4c8

Incorporated feedback

e50523f

Fixed the environment check 🤦‍♂️

6f344e9

Removed all mentions of GCDWebServer

6c5924b

kraenhansen force-pushed the kh/hermes/cleanup branch from 6a3ebd7 to 6c5924b Compare January 17, 2022 09:56

kraenhansen merged commit a6c11af into hermes Jan 17, 2022

kraenhansen deleted the kh/hermes/cleanup branch January 17, 2022 10:54

kraenhansen mentioned this pull request Jan 25, 2022

Realm has no setter or ivar for its bridge, which is not permitted, when debugging react native ios app #4258

Closed

github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up JavaScriptCore & legacy Chrome debugger RPC layer #4203

Clean up JavaScriptCore & legacy Chrome debugger RPC layer #4203

kraenhansen commented Jan 10, 2022 •

edited

Loading

fronck Jan 10, 2022

kraenhansen Jan 10, 2022

fronck Jan 12, 2022

kneth left a comment

kneth Jan 11, 2022

kneth Jan 11, 2022

fronck Jan 11, 2022

kraenhansen Jan 12, 2022 •

edited

Loading

fronck left a comment

kraenhansen commented Jan 17, 2022

CraftsmanTech11 commented Nov 13, 2022

	* Removed all code related to the legacy Chrome Debugger.
	* Removed all code related to the legacy Chrome Debugger. Please use [Flipper](https://fbflipper.com/) as debugger.

	throw new Error("This version of Realm JS doesn't support the legacy Chrome Debugger");
	throw new Error("This version of Realm JS doesn't support the legacy Chrome Debugger. Please use Flipper instead.");

Clean up JavaScriptCore & legacy Chrome debugger RPC layer #4203

Clean up JavaScriptCore & legacy Chrome debugger RPC layer #4203

Conversation

kraenhansen commented Jan 10, 2022 • edited Loading

What, How & Why?

The experience of running in legacy Chrome debugging mode

☑️ ToDos

fronck Jan 10, 2022

Choose a reason for hiding this comment

kraenhansen Jan 10, 2022

Choose a reason for hiding this comment

fronck Jan 12, 2022

Choose a reason for hiding this comment

kneth left a comment

Choose a reason for hiding this comment

kneth Jan 11, 2022

Choose a reason for hiding this comment

kneth Jan 11, 2022

Choose a reason for hiding this comment

fronck Jan 11, 2022

Choose a reason for hiding this comment

kraenhansen Jan 12, 2022 • edited Loading

Choose a reason for hiding this comment

fronck left a comment

Choose a reason for hiding this comment

kraenhansen commented Jan 17, 2022

CraftsmanTech11 commented Nov 13, 2022

kraenhansen commented Jan 10, 2022 •

edited

Loading

kraenhansen Jan 12, 2022 •

edited

Loading